RAIS  3.2
RAIS::DataAccessLayer::TableManagement Class Reference

This class implements D.A.L. methods for table management. More...

List of all members.

Static Public Member Functions

static bool IsEmptyFelds (string tableName, string fieldName)
static bool SaveTableGroup (TableGroup tableGroup, ref string returnMessage)
 This method saves a TableGroup in DB.
static Tables GetCustomTablesByTableGroup (TableGroup tableGroup)
 This method retrieves from DB custom table names for table group.
static Tables GetTablesByTableGroup (TableGroup tableGroup, bool showProtectors, bool showEvaluators)
 This method retrieves from DB table names for table group.
static Tables GetAllTables ()
 This method retrieves from DB all table names.
static Table GetTableByTableID (int id, SqlConnection sqlConnection)
 This method retrieves from DB table object by table id.
static Table GetTableByTableID (int id)
 This method retrieves from DB table object by table id.
static Table GetTableWithRelatedFieldsByTableID (int id)
 This method retrieves from DB table object by table id.
static Table GetTableWithRelatedFieldsByTableName (string tableName)
 This method retrieves from DB table object by table name.
static bool AddTable (Table table, TableGroup tableGroup, string maskName, int subcategoryID, DynamicMask.DynamicMaskType?dynamicMaskType, string dynamicMaskName, bool addForeignKeyField, bool createDynemicMasks, ref string returnMessage)
 This method adds new record in Table table.
static bool RemoveTable (Table table, ref string returnMessage)
 This method removes record from Table table.
static Fields GetFieldsByTable (Table table)
 This method retrieves from DB field names for the specified table.
static Fields GetFieldsByTable (Table table, SqlConnection sqlConnection)
 This method retrieves from DB field names for the specified table.
static Fields GetFieldsWithRelatedByTable (Table table)
 This method retrieves from DB field names for the specified table.
static Field GetFieldByID (int fieldID)
 This method retrieves from DB field by field ID.
static bool AddField (Table table, Field field, ref string returnMessage)
 This method adds new record in Field table.
static bool SaveField (Field field, ref string returnMessage)
 This method saves changes for record in Field table.
static bool SaveFieldOrder (Field field, ref string returnMessage)
 This method saves new field order in Field table.
static bool SaveFieldQueryName (Field field, ref string returnMessage)
 This method saves new field Query Name in Field table.
static bool RemoveField (Field field, ref string returnMessage)
 This method removes record from Field table.
static FieldSizes GetFieldSizesByFieldType (Field.FieldType fieldType)
 This method retrieves field sizes for field type.
static XmlDocument GetTableAndFieldXml ()
 This method retrieves Xml for [RAIS Table] and [RAIS Field] loading.
static Queries GetQueries ()
 This method retrieves from DB query names.
static Query GetQueryByQueryID (int id)
 This method retrieves from DB query object by qury id.
static Query GetQueryByQueryID (int id, SqlConnection sqlConnection)
 This method retrieves from DB query object by qury id.
static Query GetQueryByQueryName (string queryName)
 This method retrieves from DB query object by qury name.
static Queries GetQueriesByQueryType (Query.QueryType queryType)
 This method retrieves from DB query names.
static List< string > GetQueryAssignedObjectsNames (Query query)
 This method retrieves from DB query assigned objects names.
static bool AddQuery (Query query, ref string returnMessage)
 This method adds new record in Query table.
static bool SaveQuery (Query query, ref string returnMessage)
 This method saves record into Query table.
static bool RemoveQuery (Query query, ref string returnMessage)
 This method removes record from Query table.
static bool CreateQuery (Query query, ref string returnMessage)
 This method creates the SQL function for the CustomQuery and return the result of the check.
static bool CheckQuery (Query query, ref string returnMessage)
 This method checks the CustomQuery SQL text and return the result of the check.
static QueryParameters GetQueryParametersByQuery (Query query, SqlConnection sqlConnection)
 This method retrieves from DB query parameters for the specified query.
static QueryParameters GetQueryParametersByQuery (Query query)
 This method retrieves from DB query parameters for the specified query.
static bool AddQueryParameter (Query query, QueryParameter queryParameter, ref string returnMessage)
 This method adds new record in [Query Parameter] table.
static bool SaveQueryParameter (QueryParameter queryParameter, ref string returnMessage)
 This method saves changes into [Query Parameter] table.
static bool SaveQueryParameterOrder (QueryParameter queryParameter, ref string returnMessage)
 This method saves new query parameter order in [Query Parameter] table.
static bool RemoveQueryParameter (QueryParameter queryParameter, ref string returnMessage)
 This method removes record from [Query Parameter] table.
static bool CreateHistoryTable (Table table, ref string returnMessage)
 This method creates history table for selected table.
static bool IsTableContainData (Table table)

Properties

static FieldTypes FieldTypes [get]
 This property retrieves a list of all available field types.
static FieldSizes FieldSizes [get]
 This property retrieves a list of all available field sizes/formats types.
static NecessityTypes NecessityTypes [get]
 This property retrieves a list of all available field necessity types.
static TableTypes TableTypes [get]
 This property retrieves a list of all available table types.
static TableGroups TableGroups [get]
 This property retrieves a list of all available table groups.
static Tables AllTables [get]
 This property retrieves a list of all available tables.
static QueryTypes QueryTypes [get]
 This property retrieves a list of all available query types.
static QueryParameterTypes QueryParameterTypes [get]
 This property retrieves a list of all available query parameter types.

Detailed Description

This class implements D.A.L. methods for table management.


Member Function Documentation

static bool RAIS::DataAccessLayer::TableManagement::AddField ( Table  table,
Field  field,
ref string  returnMessage 
) [static]

This method adds new record in Field table.

Parameters:
tableobject for new field.
fieldobject to be added into DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 617 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::AddQuery ( Query  query,
ref string  returnMessage 
) [static]

This method adds new record in Query table.

Parameters:
queryobject to be added into DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 1005 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::AddQueryParameter ( Query  query,
QueryParameter  queryParameter,
ref string  returnMessage 
) [static]

This method adds new record in [Query Parameter] table.

Parameters:
queryobject to add parameter to
queryParameterobject to be added into DB
returnMessageMessage string about the action result
Returns:
true on success, otherwise false;

Definition at line 1323 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::AddTable ( Table  table,
TableGroup  tableGroup,
string  maskName,
int  subcategoryID,
DynamicMask.DynamicMaskType?  dynamicMaskType,
string  dynamicMaskName,
bool  addForeignKeyField,
bool  createDynemicMasks,
ref string  returnMessage 
) [static]

This method adds new record in Table table.

Parameters:
tableobject to be added into DB.
tableGroupobject for new table.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 433 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::CheckQuery ( Query  query,
ref string  returnMessage 
) [static]

This method checks the CustomQuery SQL text and return the result of the check.

Parameters:
queryobject to check the query text.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 1247 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::CreateHistoryTable ( Table  table,
ref string  returnMessage 
) [static]

This method creates history table for selected table.

Parameters:
tableobject to be added into DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 1475 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::CreateQuery ( Query  query,
ref string  returnMessage 
) [static]

This method creates the SQL function for the CustomQuery and return the result of the check.

Parameters:
queryobject to check the query text.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 1108 of file TableManagement.cs.

static Tables RAIS::DataAccessLayer::TableManagement::GetAllTables ( ) [static]

This method retrieves from DB all table names.

Returns:
dictionary of table names vs Table objects

Definition at line 292 of file TableManagement.cs.

static Tables RAIS::DataAccessLayer::TableManagement::GetCustomTablesByTableGroup ( TableGroup  tableGroup) [static]

This method retrieves from DB custom table names for table group.

Returns:
dictionary of table names vs Table objects

Definition at line 223 of file TableManagement.cs.

static Field RAIS::DataAccessLayer::TableManagement::GetFieldByID ( int  fieldID) [static]

This method retrieves from DB field by field ID.

Parameters:
filedID- field ID
Returns:
Field object

Definition at line 581 of file TableManagement.cs.

static Fields RAIS::DataAccessLayer::TableManagement::GetFieldsByTable ( Table  table) [static]

This method retrieves from DB field names for the specified table.

Parameters:
tableTable.
Returns:
dictionary of field names vs Field objects

Definition at line 510 of file TableManagement.cs.

static Fields RAIS::DataAccessLayer::TableManagement::GetFieldsByTable ( Table  table,
SqlConnection  sqlConnection 
) [static]

This method retrieves from DB field names for the specified table.

Parameters:
tableTable.
Returns:
dictionary of field names vs Field objects

Definition at line 523 of file TableManagement.cs.

static FieldSizes RAIS::DataAccessLayer::TableManagement::GetFieldSizesByFieldType ( Field.FieldType  fieldType) [static]

This method retrieves field sizes for field type.

Returns:
dictionary of field sizes vs Field Size objects

Definition at line 825 of file TableManagement.cs.

static Fields RAIS::DataAccessLayer::TableManagement::GetFieldsWithRelatedByTable ( Table  table) [static]

This method retrieves from DB field names for the specified table.

Parameters:
tableTable.
Returns:
dictionary of field names vs Field objects

Definition at line 548 of file TableManagement.cs.

static Queries RAIS::DataAccessLayer::TableManagement::GetQueries ( ) [static]

This method retrieves from DB query names.

Returns:
dictionary of query names vs Query objects

Definition at line 871 of file TableManagement.cs.

static Queries RAIS::DataAccessLayer::TableManagement::GetQueriesByQueryType ( Query.QueryType  queryType) [static]

This method retrieves from DB query names.

Returns:
dictionary of query names vs Query objects

Definition at line 955 of file TableManagement.cs.

static List<string> RAIS::DataAccessLayer::TableManagement::GetQueryAssignedObjectsNames ( Query  query) [static]

This method retrieves from DB query assigned objects names.

Parameters:
queryobject to get assigned objects to
Returns:
list of objects names

Definition at line 965 of file TableManagement.cs.

static Query RAIS::DataAccessLayer::TableManagement::GetQueryByQueryID ( int  id) [static]

This method retrieves from DB query object by qury id.

Returns:
Query object

Definition at line 880 of file TableManagement.cs.

static Query RAIS::DataAccessLayer::TableManagement::GetQueryByQueryID ( int  id,
SqlConnection  sqlConnection 
) [static]

This method retrieves from DB query object by qury id.

Returns:
Query object

Definition at line 894 of file TableManagement.cs.

static Query RAIS::DataAccessLayer::TableManagement::GetQueryByQueryName ( string  queryName) [static]

This method retrieves from DB query object by qury name.

Returns:
Query object

Definition at line 923 of file TableManagement.cs.

static QueryParameters RAIS::DataAccessLayer::TableManagement::GetQueryParametersByQuery ( Query  query,
SqlConnection  sqlConnection 
) [static]

This method retrieves from DB query parameters for the specified query.

Parameters:
queryQuery.
Returns:
dictionary of query parameter names vs QueryParameter objects

Definition at line 1271 of file TableManagement.cs.

static QueryParameters RAIS::DataAccessLayer::TableManagement::GetQueryParametersByQuery ( Query  query) [static]

This method retrieves from DB query parameters for the specified query.

Parameters:
queryQuery.
Returns:
dictionary of query parameter names vs QueryParameter objects

Definition at line 1305 of file TableManagement.cs.

static XmlDocument RAIS::DataAccessLayer::TableManagement::GetTableAndFieldXml ( ) [static]

This method retrieves Xml for [RAIS Table] and [RAIS Field] loading.

Returns:
true on success, otherwise false;

Definition at line 840 of file TableManagement.cs.

static Table RAIS::DataAccessLayer::TableManagement::GetTableByTableID ( int  id,
SqlConnection  sqlConnection 
) [static]

This method retrieves from DB table object by table id.

Returns:
Table object

Definition at line 324 of file TableManagement.cs.

static Table RAIS::DataAccessLayer::TableManagement::GetTableByTableID ( int  id) [static]

This method retrieves from DB table object by table id.

Returns:
Table object

Definition at line 352 of file TableManagement.cs.

static Tables RAIS::DataAccessLayer::TableManagement::GetTablesByTableGroup ( TableGroup  tableGroup,
bool  showProtectors,
bool  showEvaluators 
) [static]

This method retrieves from DB table names for table group.

Returns:
dictionary of table names vs Table objects

Definition at line 255 of file TableManagement.cs.

static Table RAIS::DataAccessLayer::TableManagement::GetTableWithRelatedFieldsByTableID ( int  id) [static]

This method retrieves from DB table object by table id.

Returns:
Table object

Definition at line 367 of file TableManagement.cs.

static Table RAIS::DataAccessLayer::TableManagement::GetTableWithRelatedFieldsByTableName ( string  tableName) [static]

This method retrieves from DB table object by table name.

Returns:
Table object

Definition at line 399 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::IsEmptyFelds ( string  tableName,
string  fieldName 
) [static]

Definition at line 166 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::IsTableContainData ( Table  table) [static]

Definition at line 1501 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::RemoveField ( Field  field,
ref string  returnMessage 
) [static]

This method removes record from Field table.

Parameters:
fieldobject to be removed from DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 795 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::RemoveQuery ( Query  query,
ref string  returnMessage 
) [static]

This method removes record from Query table.

Parameters:
queryobject to be removed from DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 1077 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::RemoveQueryParameter ( QueryParameter  queryParameter,
ref string  returnMessage 
) [static]

This method removes record from [Query Parameter] table.

Parameters:
queryParameterobject to be removed from DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 1444 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::RemoveTable ( Table  table,
ref string  returnMessage 
) [static]

This method removes record from Table table.

Parameters:
tableobject to be removed from DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 480 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::SaveField ( Field  field,
ref string  returnMessage 
) [static]

This method saves changes for record in Field table.

Parameters:
fieldobject to be saved into DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 674 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::SaveFieldOrder ( Field  field,
ref string  returnMessage 
) [static]

This method saves new field order in Field table.

Parameters:
fieldobject to be saved into DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 731 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::SaveFieldQueryName ( Field  field,
ref string  returnMessage 
) [static]

This method saves new field Query Name in Field table.

Parameters:
fieldobject to be saved into DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 763 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::SaveQuery ( Query  query,
ref string  returnMessage 
) [static]

This method saves record into Query table.

Parameters:
queryobject to be saved into DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 1042 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::SaveQueryParameter ( QueryParameter  queryParameter,
ref string  returnMessage 
) [static]

This method saves changes into [Query Parameter] table.

Parameters:
queryParameterobject to be saved into DB
returnMessageMessage string about the action result
Returns:
true on success, otherwise false;

Definition at line 1369 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::SaveQueryParameterOrder ( QueryParameter  queryParameter,
ref string  returnMessage 
) [static]

This method saves new query parameter order in [Query Parameter] table.

Parameters:
queryParameterobject to be saved into DB
returnMessageMessage string about the action result
Returns:
true on success, otherwise false;

Definition at line 1412 of file TableManagement.cs.

static bool RAIS::DataAccessLayer::TableManagement::SaveTableGroup ( TableGroup  tableGroup,
ref string  returnMessage 
) [static]

This method saves a TableGroup in DB.

Parameters:
tableGroup- TableGroup object.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 193 of file TableManagement.cs.


Property Documentation

Tables RAIS::DataAccessLayer::TableManagement::AllTables [static, get]

This property retrieves a list of all available tables.

Returns:
Dictionary of table names vs table objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 123 of file TableManagement.cs.

FieldSizes RAIS::DataAccessLayer::TableManagement::FieldSizes [static, get]

This property retrieves a list of all available field sizes/formats types.

Returns:
Dictionary of field size/format names vs field size/format objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 79 of file TableManagement.cs.

FieldTypes RAIS::DataAccessLayer::TableManagement::FieldTypes [static, get]

This property retrieves a list of all available field types.

Returns:
Dictionary of field type names vs field type objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 68 of file TableManagement.cs.

NecessityTypes RAIS::DataAccessLayer::TableManagement::NecessityTypes [static, get]

This property retrieves a list of all available field necessity types.

Returns:
Dictionary of field necessity names vs field necessity objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 90 of file TableManagement.cs.

QueryParameterTypes RAIS::DataAccessLayer::TableManagement::QueryParameterTypes [static, get]

This property retrieves a list of all available query parameter types.

Returns:
Dictionary of query parameter type names vs query parameter type objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 145 of file TableManagement.cs.

QueryTypes RAIS::DataAccessLayer::TableManagement::QueryTypes [static, get]

This property retrieves a list of all available query types.

Returns:
Dictionary of query type names vs query type objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 134 of file TableManagement.cs.

TableGroups RAIS::DataAccessLayer::TableManagement::TableGroups [static, get]

This property retrieves a list of all available table groups.

Returns:
Dictionary of table group names vs table group objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 112 of file TableManagement.cs.

TableTypes RAIS::DataAccessLayer::TableManagement::TableTypes [static, get]

This property retrieves a list of all available table types.

Returns:
Dictionary of table type names vs table type objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 101 of file TableManagement.cs.


The documentation for this class was generated from the following file: